<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bluetooth LE Mesh Library: API Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Bluetooth LE Mesh Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('modules.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">API Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock">The following provides a list of API documentation</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><a class="el" href="group__wiced__bt__mesh.html" target="_self">LE Mesh</a></td><td class="desc">Mesh API provides a developer a simple way to incorporate LE mesh functionality in an AIROC application </td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__core.html" target="_self">Mesh Core Library API</a></td><td class="desc">Mesh Core library of the AIROC BTSDK provide a simple method for an application to integrate Bluetooth Mesh functionality </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__client.html" target="_self">Mesh Client Library API</a></td><td class="desc">The mesh client API </td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_2_" class="arrow" onclick="toggleFolder('0_2_')">&#9660;</span><a class="el" href="group__wiced__bt__mesh__models.html" target="_self">Mesh Models Library API</a></td><td class="desc">Mesh Models library of the AIROC BTSDK provide a simple method for an application to use various Mesh models defined in the Bluetooth Mesh Model specification </td></tr>
<tr id="row_0_2_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__battery__server.html" target="_self">Mesh Battery Server</a></td><td class="desc">The AIROC Mesh Battery Server module provides a way for a client to retrieve the Battery status of this device </td></tr>
<tr id="row_0_2_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__battery__client.html" target="_self">Mesh Battery Client</a></td><td class="desc">The AIROC Mesh Battery Client module provides a way for an application to retrieve the battery status of a mesh node </td></tr>
<tr id="row_0_2_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__location__server.html" target="_self">Mesh Location Server</a></td><td class="desc">The AIROC Mesh Location Server module provides a way for a client to set the Global and Local location for a mesh device </td></tr>
<tr id="row_0_2_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__location__client.html" target="_self">Mesh Location Client</a></td><td class="desc">The AIROC Mesh Location Client module provides a way for an application to configure the device with a Global or a Local Location data or to retrieve this data </td></tr>
<tr id="row_0_2_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__onoff__server.html" target="_self">Mesh OnOff Server</a></td><td class="desc">The AIROC Mesh OnOff Server module of the Mesh Models library provides a way to implement functionality for the devices that can be controlled using a simple On/Off switch, aka On/Off client </td></tr>
<tr id="row_0_2_5_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__onoff__client.html" target="_self">Mesh OnOff Client</a></td><td class="desc">The AIROC Mesh On/Off Client module of the Mesh Models library provides a way for an application to send OnOff commands to the server and optionally receive status information </td></tr>
<tr id="row_0_2_6_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__level__server.html" target="_self">Mesh Level Server</a></td><td class="desc">The AIROC Mesh Level Server module of the Mesh Models library provides a way to implement functionality for the devices that can be controlled using a simple level slider, aka Level client </td></tr>
<tr id="row_0_2_7_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__level__client.html" target="_self">Mesh Level Client</a></td><td class="desc">The AIROC Mesh Level Client module of the Mesh Models library provides a way for an application to send Level commands (set, delta and move) to the server and optionally receive status information </td></tr>
<tr id="row_0_2_8_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__default__transition__time__server.html" target="_self">Mesh Default Transition Time Server</a></td><td class="desc">The AIROC Mesh Default Transition Time Server module of the Mesh Models library provides implementation of the Default Transition Time model </td></tr>
<tr id="row_0_2_9_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__default__transition__time__client.html" target="_self">Mesh Default Transition Time Client</a></td><td class="desc">The AIROC Mesh Default Transition Time Client module of the Mesh Models library provides a way for a controlling device to set default transition time for the devices in the mesh network </td></tr>
<tr id="row_0_2_10_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__power__onoff__server.html" target="_self">Mesh Power OnOff Server</a></td><td class="desc">The AIROC Mesh Power OnOff Server module of the Mesh Models library provides a way to implement functionality for the devices that can be controlled using a simple On/Off switch, aka On/Off client </td></tr>
<tr id="row_0_2_11_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__power__onoff__client.html" target="_self">Mesh Power OnOff Client</a></td><td class="desc">The AIROC Mesh Power On/Off Client module of the Mesh Models library provides a way for an application to manage the On Power Up behavior of other mesh devices </td></tr>
<tr id="row_0_2_12_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__power__level__server.html" target="_self">Mesh Power Level Server</a></td><td class="desc">The AIROC Mesh Power Level Server module of the Mesh Models library provides a way to implement functionality of a power plug type of a device that can be controlled using a Level slider (Generic Level client) and On/Off switch (Generic On/Off client) </td></tr>
<tr id="row_0_2_13_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__power__level__client.html" target="_self">Mesh Power Level Client</a></td><td class="desc">The AIROC Mesh Power Level Client module of the Mesh Models library provides a way for an application to control power level of the Power Level Servers in the mesh network optionally receive status information </td></tr>
<tr id="row_0_2_14_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__light__lightness__server.html" target="_self">Mesh Light Lightness Server</a></td><td class="desc">The AIROC Mesh Light Lightness Server module provides a way for an application to implement a dimmable light device which can be controlled specifically by setting the brightness, but also can be can be controlled using a Level slider (Generic Level client) and On/Off switch (Generic On/Off client) </td></tr>
<tr id="row_0_2_15_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__light__lightness__client.html" target="_self">Mesh Light Lightness Client</a></td><td class="desc">The AIROC Mesh Light Lightness Client module of the Mesh Models library provides a way for an application to control brightness level of the Light Lightness Servers in the mesh network optionally receive status information </td></tr>
<tr id="row_0_2_16_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__light__ctl__server.html" target="_self">Mesh Light CTL Server</a></td><td class="desc">The AIROC Mesh Color Temperature Lightness (CTL) Server module provides a way for an application to implement a dimmable light device with color temperature support </td></tr>
<tr id="row_0_2_17_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__light__ctl__client.html" target="_self">Mesh Light CTL Client</a></td><td class="desc">The AIROC Mesh Light CTL Client module of the Mesh Models library provides a way for an application to configure and control color lights that support Color Temperature adjustments </td></tr>
<tr id="row_0_2_18_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__light__hsl__server.html" target="_self">Mesh Light HSL Server</a></td><td class="desc">The AIROC Mesh Hue Saturation Lightness (HSL) Server module provides a way for an application to implement a dimmable light device with hue/saturation support </td></tr>
<tr id="row_0_2_19_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__light__hsl__client.html" target="_self">Mesh Light HSL Client</a></td><td class="desc">The AIROC Mesh Light HSL Client module of the Mesh Models library provides a way for an application to configure and control color lights that support Hue/Saturation control </td></tr>
<tr id="row_0_2_20_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__light__xyl__server.html" target="_self">Mesh Light xyL Server</a></td><td class="desc">The AIROC Mesh Light xyL Server module provides a way for an application to implement a dimmable light device with x and y chromaticity coordinates support </td></tr>
<tr id="row_0_2_21_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__light__xyl__client.html" target="_self">Mesh Light xyL Client</a></td><td class="desc">The AIROC Mesh Light XYL Client module of the Mesh Models library provides a way for an application to configure and control color lights that support xyL control </td></tr>
<tr id="row_0_2_22_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__model__light__lc__server.html" target="_self">Mesh Light LC Server</a></td><td class="desc">The AIROC Mesh Light LC Server module provides a way for an application to implement a Light Control Server device which can be a client to a Sensor Server model and controls the Light Lightness Actual state via defined state bindings </td></tr>
<tr id="row_0_2_23_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__light__lc__client.html" target="_self">Mesh Light LC Client</a></td><td class="desc">The AIROC Mesh Light LC Client module of the Mesh Models library provides a way for an application to configure and control lights that support LC control </td></tr>
<tr id="row_0_2_24_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__sensor__server.html" target="_self">Mesh Sensor Server</a></td><td class="desc">The AIROC Mesh Sensor Server module provides a way for an application to implement a functionality for the devices that can be controlled using sensor </td></tr>
<tr id="row_0_2_25_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__sensor__client.html" target="_self">Mesh Sensor Client</a></td><td class="desc">The AIROC Mesh Sensor Client module provides a way for an application to control Sensor Servers in the mesh network </td></tr>
<tr id="row_0_2_26_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__scene__server.html" target="_self">Mesh Scene Server</a></td><td class="desc">The AIROC Mesh Scene Server module provides a way for an application to implement a functionality for the devices that support scene state </td></tr>
<tr id="row_0_2_27_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__scene__client.html" target="_self">Mesh Scene Client</a></td><td class="desc">The AIROC Mesh Scene Client module provides a way for an application to control Scene Servers in the mesh network </td></tr>
<tr id="row_0_2_28_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__time__server.html" target="_self">Mesh Time Server</a></td><td class="desc">The AIROC Mesh Time Server module provides a way for an application to implement a functionality for the devices that support time state </td></tr>
<tr id="row_0_2_29_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__time__client.html" target="_self">Mesh Time Client</a></td><td class="desc">The AIROC Mesh Time Client module provides a way for an application to control Time Servers in the mesh network </td></tr>
<tr id="row_0_2_30_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__scheduler__server.html" target="_self">Mesh Scheduler Server</a></td><td class="desc">The AIROC Mesh Scheduler Server module provides a way for an application to implement a functionality for the devices that support Scheduler </td></tr>
<tr id="row_0_2_31_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__scheduler__client.html" target="_self">Mesh Scheduler Client</a></td><td class="desc">The AIROC Mesh Scheduler Client module provides a way for an application to control Scheduler Servers in the mesh network </td></tr>
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__wiced__bt__mesh__provisioning.html" target="_self">Mesh Provisioning Library API</a></td><td class="desc">Mesh provisioning is split into two parts </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Bluetooth LE Mesh Library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
